Skip to content

docs(autoscaler): add details about flags #7993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 21, 2025
Merged

docs(autoscaler): add details about flags #7993

merged 3 commits into from
Jul 21, 2025

Conversation

@pierreozoux
Copy link
Contributor

It is currently slightly confusing if you skim through the documentation.

For instance, see the discussion here:
#7974

I hope that by adding these 2 Important section the reader would be warned about the key difference, and need for these 2 options.

What type of PR is this?

/kind documentation

@pierreozoux
docs(autoscaler): add details about flags
8a954bc 
It is currently slightly confusing if you skim through the documentation.

For instance, see the discussion here:
kubernetes#7974

I hope that by adding these 2 Important section the reader would be warned about the key difference, and need for these 2 options.
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/cluster-autoscaler area/provider/cluster-api Issues or PRs related to Cluster API provider labels Mar 28, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @pierreozoux. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 28, 2025
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 28, 2025
@pierreozoux
Copy link
Contributor Author

pierreozoux commented Mar 28, 2025 •
edited
Loading

@elmiko maybe this way?
(I'm no professional doc writer, but I hope it helps :) )

jackfrancis
jackfrancis reviewed Mar 28, 2025
View reviewed changes
jackfrancis
jackfrancis reviewed Mar 28, 2025
View reviewed changes
@elmiko
Copy link
Contributor

elmiko commented Apr 15, 2025

hey, apologies, i was out for kubecon and then pto. i need to give this some thought, will add it to my queue for this week.

elmiko
elmiko reviewed Apr 16, 2025
View reviewed changes
Copy link
Contributor

@elmiko elmiko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it's difficult to summarize how these flags are used because their use can change slightly depending on how the topology is configured.

@pierreozoux
Copy link
Contributor Author

Thanks for your help, I did implement your recommendations.

jackfrancis
jackfrancis reviewed Apr 17, 2025
View reviewed changes
cluster-autoscaler/cloudprovider/clusterapi/README.md
## Connecting cluster-autoscaler to Cluster API management and workload Clusters

> [!IMPORTANT]
> `--cloud-config` is the flag for specifying a mount volume path to the kubernetes configuration (ie KUBECONFIG) to the cluster-autoscaler for communicating with the cluster-api management cluster for the purpose of scaling machines.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove "to the cluster-autoscaler" for both of these, as that relationship is already implied, I think (and it stutters following the "to the kubernetes configuration" part of the sentence).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i was trying to be as specific as possible given the context, perhaps "for the cluster-autoscaler" ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ya I think that's better

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 17, 2025
@elmiko
Copy link
Contributor

elmiko commented Jul 17, 2025

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 17, 2025
elmiko
elmiko reviewed Jul 17, 2025
View reviewed changes
Copy link
Contributor

@elmiko elmiko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what happened here, i'm pretty sure we want to merge this.

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 17, 2025
@elmiko
Copy link
Contributor

elmiko commented Jul 18, 2025

/retest

@elmiko
Copy link
Contributor

elmiko commented Jul 21, 2025

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: elmiko, pierreozoux

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 21, 2025
@k8s-ci-robot k8s-ci-robot merged commit 0d14eca into kubernetes:master Jul 21, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jackfrancis jackfrancis jackfrancis left review comments

@hardikdr hardikdr Awaiting requested review from hardikdr

+1 more reviewer

@elmiko elmiko elmiko left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@elmiko elmiko

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/cluster-autoscaler area/provider/cluster-api Issues or PRs related to Cluster API provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@pierreozoux @k8s-ci-robot @elmiko @k8s-triage-robot @jackfrancis